WinCLI Help Index

The Index contains a list of all Help topics available for WinCLI. For information on how to use the Help system, press F1 or choose Using Help from the Help menu.

Basics

Introduction	Introduction to WinCLI.

Quick Tips	Quick tips on using WinCLI.

Keyboard

Window	Scrolling the virtual buffer.

Line editing	Editing the command line.

History	Recalling previous entries.

Menus

System	Various system functions.

Commands

Internal	List of WinCLI commands.

Configuration

Startup	Modifying startup values.

Glossary

Terms	Special terms used in WinCLI.


Index

The Index contains a list of all Help topics available for WinCLI. For information on how to use the Help system, press F1 or choose Using Help from the Help menu.


Help system

The help system is a program that is part of Windows.  It is designed to provide the user with information on the program they are using.  To learn how to use the Help system, press F1 or choose Using Help from the Help menu.


WIN.INI

The WIN.INI file contains setup and configuration information for WinCLI and for Windows.   For more information on WIN.INI and how to modify and add sections, please refer to the manual included with Windows and WININI.TXT.


PATH (Environment variable)

PATH is an environment variable that tells MS-DOS which user specified directories to search through if a program or batch file is not found on the current directory.


Wildcards

A wildcard is either ? or *.  ? matches any one character in the file name.  * matches any number of characters in a file name.  Check your MS-DOS manual for more information on how to use wildcards.


Command.com

Command.com is the program that acts as the primary DOS shell.  You use Command.com everytime you start a program, ask for a directory, or copy a file.  Check your MS-DOS manual for more information.


Hidden files

A hidden file is normally invisible to commands such as DIR.  However, with WinCLI you can use the ATTRIB command to view hidden files.  Check your MS-DOS manual for more information on finding and removing hidden files.


Associations

Windows lets you associate a document with an application.  When you select the document, the associated application is run and the document loaded.  Check your Windows manual for more information on associating documents with applications.


SUBSTitute drives

The DOS command SUBST let's you associate a path with a drive letter.  The drive letter assigned represents a virtual drive because it doesn't really exist.  For more information on SUBSTitute drives check the SUBST command in your DOS manual.


Control Panel

The Control Panel is a program that allows you to modify and configure Windows' default settings.  Check your Windows manual for more information on where to find, and how to use, the Control Panel.


Glossary

Associations

Command.com

Control Panel

Help system

Hidden files

Index

Path

SUBST

Wildcards

WIN.INI


Introduction

What is WinCLI and why should I use it?

WinCLI is a command line interpreter for Windows 3.  It performs most of the functions that the standard DOS prompt, Command.com, does.  Then why do you need WinCLI?  Many reasons...

1)	With WinCLI you are able to run Windows programs by typing their name instead of looking for an icon.  So if you like the functionality of the DOS prompt to start programs, you can now use WinCLI to start Windows applications.

2)	A DOS prompt in enhanced mode wastes over 640 Kb all the time.  Even when if you are not running a program.  That means that you are wasting precious memory that Windows could otherwise use.  Even if you create a special PIF that uses only enough memory to allow simple file operations (you will not be able to run programs because it does not have enough memory), you are still wasting over 256 Kb.  WinCLI requires less than 50 KBytes when fully loaded.

3)	WinCLI works equally well on all Windows modes.  You do not need a 386 to take advantage of WinCLI.  You can now have a complete command line, in a window, even in standard or real mode.

4)	WinCLI is a Windows application so it does not have to be manually closed when you quit your Windows session.  You do not even have to type exit (although you can), the close menu works just fine!

5)	WinCLI is very configurable.  It supports a scrollable window with an adjustable height and width.  You can place as many lines as you need to see.  For example if you want to show a directory listing and then do a group of individual deletes, you just scroll up with the cursor keys to see the listing, even if it is off the visible portion of the screen!  The prompt, font, and colors are also adjustable.

6)	WinCLI comes with command line history, cursor key line editing and aliases built-in.  No need to use memory wasting TSRs.

7)	WinCLI is easy to use and includes a complete online Help system.  In order to optain help on a WinCLI command just type Help [Command] (where [Command] is the WinCLI command you want help on.  Ex:  Help Dir) at the WinCLI command line or select one of the menus.

8)	Of course you also have all the normal features of a standard DOS shell.  You can show directories, create subdirectories, rename files, delete files, and much, much more!


Quick tips

Although WinCLI works a lot like the standard DOS prompt, it is not an exact replacement.  We strongly recommend that you be familiar with the operation of the DOS prompt before you attempt to use WinCLI.

You can run Windows or DOS programs from WinCLI just like you would at the standard DOS prompt.  If you do not specify a complete path, the current directory is searched first, then the standard path.  WinCLI provides a method to request that a program be run in normal, maximized, or minimized mode.

D:> Label	Runs the built-in label command.

D:> @Label	Runs the REAL Label command in normal mode.  This is useful if you want to run a command that has the same name as an internal command.  Think of it as an override.

D:> Notepad	Runs Notepad in normal mode.

D:> +Notepad	Runs Notepad in maximized mode.

D:> =Notepad	Runs Notepad in minimized and active mode.

D:> -Notepad	Runs Notepad in minimized and inactive mode.

WinCLI also allows you to run programs through their associated files.  For example, using the default Windows settings in the WIN.INI, typing...

C:\WINDOWS> Winini.txt

...would cause Notepad to be run and the file Winini.txt loaded.  This is a very convenient way of starting programs when you know what file you want to load.  For more information on associations and file extensions look in your Windows manual and in the WinIni.txt file.

You can interrupt an internal command by pressing the ESC, CTRL-C, or CTRL-Break keys.  You can also pause a program's display by pressing PAUSE.  Any other key will restart the display.

WinCLI let's you change the directories quickly by typing their name in without needing the ChDir or CD command.  For example these two commands have the same effect:

D:> CD C:\Windows

D:> C:\Windows

This is usually refered to as an implicit directory change.


Configuring WinCLI

WinCLI allows you to configure certain settings by adding a special section in the Windows WIN.INI file.  Using NotePad or SysEdit, add an entry for WinCLI at the end of the WIN.INI file.  The entry heading must be called [WINCLI].

WinCLI recognizes the following subsections:

Prompt	Check Prompt for more information on the settings.

Font	System, Courier or OEM.  Use System on MONO, CGA, EGA, and VGA systems.  Use Courier on 8514/A or SVGA systems.  You only need to use OEM if you use characters above 127 ASCII in your filenames.

Colors	Normal, Inverse or DOS.  WinCLI uses the system colors for the text and the background of the shell.  If you use Inverse WinCLI will inverse the system values you have selected.  You can modify the system colors with the Windows Control Panel.  The DOS setting emulates the grey on black of the standard DOS prompt.

Virtual Height	Any value greater than 24.  This is the size of the scrollable field.

Virtual Width	Any value greater than 79.  This is the size of the scrollable field.

Window Height	Any value greater than 0.  This is the size (in pixels) of the Window.  A value of 0 will will make the window open with a default size.

Window Width	Any value greater than 0.  This is the size (in pixels) of the Window.  A value of 0 will will make the window open with a default size.

For example, these are the default settings:

[WINCLI]

Prompt=$n$g

Font=System

Colors=Normal

Virtual Height=25

Virtual Width=80

Window Height=0

Window Width=0


Keyboard

To get help for a subject, click the appropriate word.

Window	Scrolling the virtual buffer.

Line editing	Editing the command line.

History	Recalling previous entries.


Window Keyboard Controls

Key(s)	Function

Shift+Left	Scrolls the window left one character.

Shift+Right	Scrolls the window right one character.

Shift+Up	Scrolls the window up one line.

Shift+Down	Scrolls the window down one line.

Page Up	Scrolls the window up one notch.

Page Down	Scrolls the window down one notch.

Shift+Page Up	Scrolls the window left one notch.

Shift+Page Down	Scrolls the window right one notch.

Shift+Top	Scrolls the window to the top.

Shift+Down	Scrolls the window to the bottom.


Editing Keyboard Controls

Key(s)	Function

Left	Moves the cursor back one character.

Right	Moves the cursor forward one character.

Home	Moves the cursor to the start of the line.

End	Moves the cursor to the end of the line.

Delete	Deletes the character to the right of the cursor.

Backspace	Deletes the character under the cursor.


History Keyboard Controls

Key(s)	Function

Up	Recalls the command in the history list before the one displayed.

Down	Recalls the command in the history list after the one displayed.


Menus

To get help for a subject, click the approriate word.

System	Various system functions.


System Menu

Arrange Icons

Arranges all icons on the desktop in rows.

Cascade Windows

Arranges windows in an overlapping pattern so that the title bar of each window remains visible.

Tile Windows

Arranges windows side by side so that all windows are visible.

Exit Windows

Terminates your Windows session.


Attrib

Internal

Attrib	[D:\Directory\File] [+R|-R, +A|-A, +H|-H, +S|-S] [/P, /S]

Displays, sets or removes a file's (or group of files') attributes.  Wildcards are permitted.  If no directory is specified then the current directory is used.

A + and a letter (R, A, H, or S) sets that attribute.  A - and a letter clears that attribute.  If you do not include a switch (+ or -) the attributes of the file(s) are displayed similiar to a directory listings.

The /S switch allows you to perform the operation on all subdirectories in the specified directory.

The /P switch will have WinCLImpt you to continue when a listing fills the screen.  If you press N the listing will stop, anything else will let it continue.

Examples:

Attrib *.Doc +R -A

or

Attrib *.Txt

or

Attrib *.* -A /S


ChDir or CD

Internal

ChDir	[D:\Directory]

Changes the current directory.  You may optionally include the drive and directory you want to switch to.  If no parameters are specified the current directory is displayed.

NOTE: You may also change directories by just typing the name of the drive and directory you want to go to without typing the ChDir command.

Examples:

ChDir C:\Windows\WinWord

or

C:\Windows\WinWord


Cls

Internal

Cls

Clears the display and the buffer, then it resets the prompt to the top.

Examples:

Cls


Copy

Internal

Copy	D:\FromDirectory[\File] [D:\ToDirectory[\File]]

Copies files from one directory to another.  Wildcards are permitted.

If you use wildcards as the destination, the characters represented by the wildcards will be identical to the corresponding characters in the source.

For example:

Copy *.TXT *.DOC

will copy all files ending with .TXT to the same names but ending with .DOC.

If a directory is specified as the source, all the files in that directory (but not the subdirectories) are copied to the destination.

If no directory is specified as the destination then the current directory is used.

Examples:

Copy C:\Windows\Temp D:\Temp

or

Copy C:\Windows\Temp\*.bak D:\Temp


Date

Internal

Date

Displays the current system date.

Examples:

Date


Del or Erase

Internal

Del	D:\Directory\File... [/P]

Deletes a file or group of files.  Wildcards are permitted.  If both the filename and the extension contain * as the wildcard, Delete will ask you if you are sure you want to continue.

You may enter more than one file specification on the command line.

The /P switch prompts you for confirmation before deleting each of the specified files.

Examples:

Del C:\Windows\Temp\*.bak

or

Del Win.syd Win.bak *.tmp


Dir

Internal

Dir	[D:\Directory[\File]] [/W, /P]

Displays a directory listing of all the files and directories matching the wildcard specification.  If no parameters are entered *.* is used.

You can use the /P switch to have WinCLImpt you to continue when a directory listing fills the screen.  If you press N the listing will stop, anything else will let it continue.

You can use the /W switch or the Dirw command to display a wide listing that only includes the file and directory names, not the size, date, and attributes.

Examples:

Dir C:\Windows\*.EXE

or

Dir C:\Windows\*.* /P


Exit

Internal

Exit

Terminates the current WinCLI shell.

Examples:

Exit


Help

Internal

Help	[Keywords]

Brings up the WinCLI help system using the specified keywords.  The keywords can be any of the keywords (or phrases) that appear in the help system.

Examples:

Help

or

Help Attrib

or

Help Internal Commands


Label

External

Label	D:[Disk label]

Creates, changes or deletes a volume label for a disk.  You must specify the drive you want to change.  The disk's old label will be replaced by a new label.  If you do not include a new label, the old label is erased.

Examples:

Label C:MainDisk

or

Label C:


Mem

Internal

Mem

Displays available system memory.

Examples:

Mem


MkDir or Md

Internal

MkDir	D:\Directory

Creates a new subdirectory.  The name of the directory you want to create must be unique, there must not be another file or subdirectory with the same name.

Examples:

MkDir C:\Windows\Temp


More or Type

External

More	D:\Directory\File [/P, /T:??]

Displays a file, preferably a text (ASCII) file.

You can use the /P switch to have WinCLImpt you to continue when the screen gets full.  If you press N the listing will stop, anything else will let it continue.

The /T switch allows you to specify the amount of spaces to replace a TAB with.  This can be anywhere from 1 to 16.

Examples:

More C:\Windows\Winini.txt

or

More C:\Windows\Winini.txt /P /T:4


Move

Internal

Move	D:\FromDirectory[\File] [D:\ToDirectory[\File]]

Moves files from one directory to another.  Wildcards are permitted.

If you use wildcards as the destination, the characters represented by the wildcards will be identical to the corresponding characters in the source.

For example:

Move *.TXT *.DOC

will move all files ending with .TXT to the same names but ending with .DOC.

If a directory is specified as the source, all the files in that directory (but not the subdirectories) are copied to the destination.

If no directory is specified as the destination then the current directory is used.

Move renames the files if the source and destination drive are the same.  If they are not the same it copies the files and then deletes the originals.

Examples:

Move C:\Windows\Temp C:\Trash

or

Move C:\Windows\Temp\*.bak D:\Temp

or

Move C:\Autoexec.bat


Path

Internal

Path

Displays the system PATH environment variable.

Examples:

Path


Prompt

Internal

Prompt	[[$] Text]

Change the prompt string using text or optional meta-string values.  If no parameters are specified, the current prompt is displayed.

A meta-string is composed of the dollar sign, $, and one of the following characters.

_	Start a new line.

b	|, Vertical bar

d	Current system date.

g	>, Greater than sign.

i	WinCLI instance number.

l	<, Less than sign.

m	Available memory.

n	Current drive.

p	Current drive and path.

r	Free system resources.

t	Current system time.

z	Sound a bell.

$	Dollar sign.  ($$ = 1 dollar sign)

If you use the $p meta-string in a prompt, WinCLI reads your disk after each command you enter to determine the current drive and path.  This can take extra time, especially on floppy disk drives.

Examples:

Prompt

or

Prompt Hello master!$_$p$g


Rename or Ren

Internal

Rename	D:\Directory\Old D:\Directory\New

Renames a file from old to new.  Old is the original name and new is the new name you want to give to the file.  Wildcards are permitted.

If you use wildcards as the destination, the characters represented by the wildcards will be identical to the corresponding characters in the source.

For example:

Rename *.TXT *.DOC

will rename all files ending with .TXT to the same names but ending with .DOC.

Examples:

Rename TestFile.1st TestFile.2nd


RmDir or Rd

Internal

RmDir	D:\Directory

Removes an empty subdirectory.  It must contain no files or subdirectories.  If you get an error removing an empty subdirectory make sure there are no hidden files.

Examples:

RmDir C:\Windows\Temp

or

RmDir C:\Windows /S


SysInfo

External

SysInfo

Displays various information on PC, DOS and Windows.

Examples:

SysInfo


Time

Internal

Time

Displays the current system time.

Examples:

Time


Ver

Internal

Ver

Displays WinCLI version information.

Examples:

Ver


Verify

Internal

Verify	On|Off

Turns the DOS verify flag on or off.  Check your DOS (under verify) manual for more information.

Examples:

Vol ON

or

Vol OFF


Vol

External

Vol	[D:]

Displays the volume label of the disk in the specified drive.  If no parameter is specified then the current drive is used.

Examples:

Vol A

or

Vol


WinCLI Commands

Attrib	Displays, sets or removes files' attributes.

ChDir or CD	Displays or changes the current directory.

Cls	Clears the display.

Copy	Copies files.  Wildcards are permitted.

Date	Displays current system date.

Del or Erase	Deletes files.  Wildcards are permitted.

Dir	Displays files and subdirectories.  Wildcards are permitted.

Exit	Terminates current WinCLI window.

Help	Invokes command specific help.

Label	Sets or clears volume labels.

Mem	Displays available system memory.

MkDir or MD	Creates a new subdirectory.

More or Type	Displays text files.

Move	Moves files.  Wildcards are permitted.

Path	Displays PATH environment variable.

Prompt	Changes the prompt or displays the current value.

Rename or Ren	Renames a file.

RmDir or Rd	Removes a subdirectory.

SysInfo	Displays system information.

Time	Displays current system time.

Ver	Displays current WinCLI version information.

Verify	Sets or clears the DOS verfiy flag.

Vol	Displays the current volume label.